home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / catD / stroptions.z / stroptions
Encoding:
Text File  |  1998-10-30  |  14.7 KB  |  199 lines
  1.  
  2.  
  3.  
  4. ssssttttrrrrooooppppttttiiiioooonnnnssss((((DDDD4444))))                                                  ssssttttrrrrooooppppttttiiiioooonnnnssss((((DDDD4444))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      _ssss_tttt_rrrr_oooo_pppp_tttt_iiii_oooo_nnnn_ssss - stream head option structure
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee _<<<<_ssss_yyyy_ssss_////_ssss_tttt_rrrr_eeee_aaaa_mmmm_...._hhhh_>>>>
  13.      _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee _<<<<_ssss_yyyy_ssss_////_ssss_tttt_rrrr_oooo_pppp_tttt_ssss_...._hhhh_>>>>
  14.      _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee _<<<<_ssss_yyyy_ssss_////_dddd_dddd_iiii_...._hhhh_>>>>
  15.  
  16. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  17.      The _ssss_tttt_rrrr_oooo_pppp_tttt_iiii_oooo_nnnn_ssss structure, used in an _MMMM______SSSS_EEEE_TTTT_OOOO_PPPP_TTTT_SSSS message, contains options
  18.      for the stream head.
  19.  
  20. UUUUSSSSAAAAGGGGEEEE
  21.      The _MMMM______SSSS_EEEE_TTTT_OOOO_PPPP_TTTT_SSSS message is sent upstream by drivers and modules when they
  22.      want to change stream head options for their stream.
  23.  
  24.    SSSSttttrrrruuuuccccttttuuuurrrreeee DDDDeeeeffffiiiinnnniiiittttiiiioooonnnnssss
  25.      The _ssss_tttt_rrrr_oooo_pppp_tttt_iiii_oooo_nnnn_ssss structure contains the following members:
  26.  
  27.      _uuuu_llll_oooo_nnnn_gggg______tttt   _ssss_oooo______ffff_llll_aaaa_gggg_ssss_;;;;    _////_**** _oooo_pppp_tttt_iiii_oooo_nnnn_ssss _tttt_oooo _ssss_eeee_tttt _****_////
  28.      _ssss_hhhh_oooo_rrrr_tttt     _ssss_oooo______rrrr_eeee_aaaa_dddd_oooo_pppp_tttt_;;;;  _////_**** _rrrr_eeee_aaaa_dddd _oooo_pppp_tttt_iiii_oooo_nnnn _****_////
  29.      _uuuu_ssss_hhhh_oooo_rrrr_tttt______tttt  _ssss_oooo______wwww_rrrr_oooo_ffff_ffff_;;;;    _////_**** _wwww_rrrr_iiii_tttt_eeee _oooo_ffff_ffff_ssss_eeee_tttt _****_////
  30.      _llll_oooo_nnnn_gggg      _ssss_oooo______mmmm_iiii_nnnn_pppp_ssss_zzzz_;;;;   _////_**** _mmmm_iiii_nnnn_iiii_mmmm_uuuu_mmmm _rrrr_eeee_aaaa_dddd _pppp_aaaa_cccc_kkkk_eeee_tttt _ssss_iiii_zzzz_eeee _****_////
  31.      _llll_oooo_nnnn_gggg      _ssss_oooo______mmmm_aaaa_xxxx_pppp_ssss_zzzz_;;;;   _////_**** _mmmm_aaaa_xxxx_iiii_mmmm_uuuu_mmmm _rrrr_eeee_aaaa_dddd _pppp_aaaa_cccc_kkkk_eeee_tttt _ssss_iiii_zzzz_eeee _****_////
  32.      _uuuu_llll_oooo_nnnn_gggg______tttt   _ssss_oooo______hhhh_iiii_wwww_aaaa_tttt_;;;;    _////_**** _rrrr_eeee_aaaa_dddd _qqqq_uuuu_eeee_uuuu_eeee _hhhh_iiii_gggg_hhhh _wwww_aaaa_tttt_eeee_rrrr _mmmm_aaaa_rrrr_kkkk _****_////
  33.      _uuuu_llll_oooo_nnnn_gggg______tttt   _ssss_oooo______llll_oooo_wwww_aaaa_tttt_;;;;    _////_**** _rrrr_eeee_aaaa_dddd _qqqq_uuuu_eeee_uuuu_eeee _llll_oooo_wwww _wwww_aaaa_tttt_eeee_rrrr _mmmm_aaaa_rrrr_kkkk _****_////
  34.      _uuuu_cccc_hhhh_aaaa_rrrr______tttt   _ssss_oooo______bbbb_aaaa_nnnn_dddd_;;;;     _////_**** _bbbb_aaaa_nnnn_dddd _ffff_oooo_rrrr _wwww_aaaa_tttt_eeee_rrrr _mmmm_aaaa_rrrr_kkkk_ssss _****_////
  35.      The _ssss_oooo______ffff_llll_aaaa_gggg_ssss field determines which options are to be set, and which of
  36.      the other fields in the structure are used.  This field is a bitmask and
  37.      is comprised of the bit-wise OR of the following flags:
  38.  
  39.           _SSSS_OOOO______RRRR_EEEE_AAAA_DDDD_OOOO_PPPP_TTTT      Set the read option to that specified by the
  40.                           _ssss_oooo______rrrr_eeee_aaaa_dddd_oooo_pppp_tttt field.
  41.  
  42.           _SSSS_OOOO______WWWW_RRRR_OOOO_FFFF_FFFF        Set the write offset to that specified by the
  43.                           _ssss_oooo______wwww_rrrr_oooo_ffff_ffff field.
  44.  
  45.           _SSSS_OOOO______MMMM_IIII_NNNN_PPPP_SSSS_ZZZZ       Set the minimum packet size on the stream head read
  46.                           queue to that specified by the _ssss_oooo______mmmm_iiii_nnnn_pppp_ssss_zzzz field.
  47.  
  48.           _SSSS_OOOO______MMMM_AAAA_XXXX_PPPP_SSSS_ZZZZ       Set the maximum packet size on the stream head read
  49.                           queue to that specified by the _ssss_oooo______mmmm_aaaa_xxxx_pppp_ssss_zzzz field.
  50.  
  51.           _SSSS_OOOO______HHHH_IIII_WWWW_AAAA_TTTT        Set the high water mark on the stream head read
  52.                           queue to that specified by the _ssss_oooo______hhhh_iiii_wwww_aaaa_tttt field.
  53.  
  54.           _SSSS_OOOO______LLLL_OOOO_WWWW_AAAA_TTTT        Set the low water mark on the stream head read queue
  55.                           to that specified by the _ssss_oooo______llll_oooo_wwww_aaaa_tttt field.
  56.  
  57.           _SSSS_OOOO______AAAA_LLLL_LLLL          Set all of the above options (_SSSS_OOOO______RRRR_EEEE_AAAA_DDDD_OOOO_PPPP_TTTT _|||| _SSSS_OOOO______WWWW_RRRR_OOOO_FFFF_FFFF
  58.                           _|||| _SSSS_OOOO______MMMM_IIII_NNNN_PPPP_SSSS_ZZZZ _|||| _SSSS_OOOO______MMMM_AAAA_XXXX_PPPP_SSSS_ZZZZ _|||| _SSSS_OOOO______HHHH_IIII_WWWW_AAAA_TTTT _|||| _SSSS_OOOO______LLLL_OOOO_WWWW_AAAA_TTTT).
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. ssssttttrrrrooooppppttttiiiioooonnnnssss((((DDDD4444))))                                                  ssssttttrrrrooooppppttttiiiioooonnnnssss((((DDDD4444))))
  71.  
  72.  
  73.  
  74.           _SSSS_OOOO______MMMM_RRRR_EEEE_AAAA_DDDD_OOOO_NNNN      Turn on generation of _MMMM______RRRR_EEEE_AAAA_DDDD messages by the stream
  75.                           head.
  76.  
  77.           _SSSS_OOOO______MMMM_RRRR_EEEE_AAAA_DDDD_OOOO_FFFF_FFFF     Turn off generation of _MMMM______RRRR_EEEE_AAAA_DDDD messages by the stream
  78.                           head.
  79.  
  80.           _SSSS_OOOO______NNNN_DDDD_EEEE_LLLL_OOOO_NNNN       Use old TTY semantics for no-delay reads and writes.
  81.  
  82.           _SSSS_OOOO______NNNN_DDDD_EEEE_LLLL_OOOO_FFFF_FFFF      Use STREAMS semantics for no-delay reads and writes.
  83.  
  84.           _SSSS_OOOO______IIII_SSSS_TTTT_TTTT_YYYY        The stream is acting as a terminal.
  85.  
  86.           _SSSS_OOOO______IIII_SSSS_NNNN_TTTT_TTTT_YYYY       The stream is no longer acting as a terminal.
  87.  
  88.           _SSSS_OOOO______TTTT_OOOO_SSSS_TTTT_OOOO_PPPP       Stop processes on background writes to this stream.
  89.  
  90.           _SSSS_OOOO______TTTT_OOOO_NNNN_SSSS_TTTT_OOOO_PPPP      Don't stop processes on background writes to this
  91.                           stream.
  92.  
  93.           _SSSS_OOOO______BBBB_AAAA_NNNN_DDDD         The water marks changes affect the priority band
  94.                           specified by the _ssss_oooo______bbbb_aaaa_nnnn_dddd field.
  95.  
  96.      The _ssss_oooo______rrrr_eeee_aaaa_dddd_oooo_pppp_tttt field specifies options for the stream head that alter the
  97.      way it handles _rrrr_eeee_aaaa_dddd(2) calls.  This field is a bitmask whose flags are
  98.      grouped in sets.  Within a set, the flags are mutually exclusive.  The
  99.      first set of flags determines how data messages are treated when they are
  100.      read:
  101.  
  102.           _RRRR_NNNN_OOOO_RRRR_MMMM           Normal (byte stream) mode.  _rrrr_eeee_aaaa_dddd returns the lesser
  103.                           of the number of bytes asked for and the number of
  104.                           bytes available.  Messages with partially read data
  105.                           are placed back on the head of the stream head read
  106.                           queue.  This is the default behavior.
  107.  
  108.           _RRRR_MMMM_SSSS_GGGG_DDDD           Message discard mode.  _rrrr_eeee_aaaa_dddd returns the lesser of
  109.                           the number of bytes asked for and the number of
  110.                           bytes in the first message on the stream head read
  111.                           queue.  Messages with partially read data are freed.
  112.  
  113.           _RRRR_MMMM_SSSS_GGGG_NNNN           Message non-discard mode.  _rrrr_eeee_aaaa_dddd returns the lesser
  114.                           of the number of bytes asked for and the number of
  115.                           bytes in the first message on the stream head read
  116.                           queue.  Messages with partially read data are placed
  117.                           back on the head of the stream head read queue.
  118.  
  119.      The second set of flags determines how protocol messages (_MMMM______PPPP_RRRR_OOOO_TTTT_OOOO and
  120.      _MMMM______PPPP_CCCC_PPPP_RRRR_OOOO_TTTT_OOOO) are treated during a _rrrr_eeee_aaaa_dddd:
  121.  
  122.           _RRRR_PPPP_RRRR_OOOO_TTTT_NNNN_OOOO_RRRR_MMMM       Normal mode.  _rrrr_eeee_aaaa_dddd fails with the error code _EEEE_BBBB_AAAA_DDDD_MMMM_SSSS_GGGG
  123.                           if there is a protocol message at the front of the
  124.                           stream head read queue.  This is the default
  125.                           behavior.
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. ssssttttrrrrooooppppttttiiiioooonnnnssss((((DDDD4444))))                                                  ssssttttrrrrooooppppttttiiiioooonnnnssss((((DDDD4444))))
  137.  
  138.  
  139.  
  140.           _RRRR_PPPP_RRRR_OOOO_TTTT_DDDD_IIII_SSSS        Protocol discard mode.  _rrrr_eeee_aaaa_dddd discards the _MMMM______PPPP_RRRR_OOOO_TTTT_OOOO or
  141.                           _MMMM______PPPP_CCCC_PPPP_RRRR_OOOO_TTTT_OOOO portions of the message and return any
  142.                           _MMMM______DDDD_AAAA_TTTT_AAAA portions that may be present.  _MMMM______PPPP_AAAA_SSSS_SSSS_FFFF_PPPP
  143.                           messages are also freed in this mode.
  144.  
  145.           _RRRR_PPPP_RRRR_OOOO_TTTT_DDDD_AAAA_TTTT        Protocol data mode.  _rrrr_eeee_aaaa_dddd treats the _MMMM______PPPP_RRRR_OOOO_TTTT_OOOO or
  146.                           _MMMM______PPPP_CCCC_PPPP_RRRR_OOOO_TTTT_OOOO portions of the message as if they were
  147.                           normal data (that is, they are delivered to the
  148.                           user.)
  149.  
  150.      The _ssss_oooo______wwww_rrrr_oooo_ffff_ffff field specifies a byte offset to be included in the first
  151.      message block of every _MMMM______DDDD_AAAA_TTTT_AAAA message created by a _wwww_rrrr_iiii_tttt_eeee(2) and the first
  152.      _MMMM______DDDD_AAAA_TTTT_AAAA message block created by each call to _pppp_uuuu_tttt_mmmm_ssss_gggg(2).
  153.  
  154.      The _ssss_oooo______mmmm_iiii_nnnn_pppp_ssss_zzzz field specifies the minimum packet size for the stream head
  155.      read queue.
  156.  
  157.      The _ssss_oooo______mmmm_aaaa_xxxx_pppp_ssss_zzzz field specifies the maximum packet size for the stream head
  158.      read queue.
  159.  
  160.      The _ssss_oooo______hhhh_iiii_wwww_aaaa_tttt field specifies the high water mark for the stream head read
  161.      queue.
  162.  
  163.      The _ssss_oooo______llll_oooo_wwww_aaaa_tttt field specifies the low water mark for the stream head read
  164.      queue.
  165.  
  166.      The _ssss_oooo______bbbb_aaaa_nnnn_dddd field specifies the priority band to which the high and/or
  167.      low water mark changes should be applied.
  168.  
  169. RRRREEEEFFFFEEEERRRREEEENNNNCCCCEEEESSSS
  170.      _dddd_aaaa_tttt_aaaa_bbbb(D4), _mmmm_eeee_ssss_ssss_aaaa_gggg_eeee_ssss(D5), _mmmm_ssss_gggg_bbbb(D4), _rrrr_eeee_aaaa_dddd(2), _ssss_tttt_rrrr_eeee_aaaa_mmmm_iiii_oooo(7)
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.